
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>Setup &#8212; iprPy 0.10.2 documentation</title>
    <link rel="stylesheet" href="_static/basic.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>
    <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="iprPy Package Components" href="overview.html" />
    <link rel="prev" title="Introduction to iprPy" href="intro.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="overview.html" title="iprPy Package Components"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="intro.html" title="Introduction to iprPy"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">iprPy 0.10.2 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="setup">
<h1>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h1>
<p>A key principle of iprPy is to minimize barriers for usage.  As such, the only
requirements for running the framework are Python 3.6+, and a few extra (mostly
standard) Python packages.  All of the required packages should be compatible
with any operating system that Python runs on.</p>
<div class="section" id="installing-iprpy">
<h2>Installing iprPy<a class="headerlink" href="#installing-iprpy" title="Permalink to this headline">¶</a></h2>
<ol class="arabic">
<li><p>Install Python 3.6+ and the <a class="reference external" href="https://www.scipy.org/">scipy</a> family of Python packages.  If you
don’t already have Python, the easiest way to do this is to install
<a class="reference external" href="https://www.continuum.io/downloads">Anaconda</a>.  The standard Anaconda distribution automatically adds the
scipy packages.  For miniconda or a new environment of an existing anaconda
installation, use the conda command to install the scipy packages.</p></li>
<li><p>Fork and clone, or download iprPy from GitHub.  The repository for the
stable versions is available at <a class="reference external" href="https://github.com/usnistgov/iprPy">https://github.com/usnistgov/iprPy</a>.</p></li>
<li><p>In a terminal, go into the local iprPy root directory and install the iprPy
package to Python with the command</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">python setup.py develop</span>
</pre></div>
</div>
<p>This should automatically install any other required Python packages.</p>
</li>
<li><p>To test if the framework is working, in a terminal go into the iprPy/bin
directory and enter the command</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">python iprPy check_modules</span>
</pre></div>
</div>
<p>If you see a list of included calculation, record, and database styles,
then it is working!</p>
</li>
<li><p>The list printed in the last step indicates the iprPy modules that were
successfully and unsuccessfully loaded.  If a module did not load, then
either the module has additional package requirements or has not yet been
fully implemented into iprPy.</p></li>
</ol>
</div>
<div class="section" id="updating-iprpy">
<h2>Updating iprPy<a class="headerlink" href="#updating-iprpy" title="Permalink to this headline">¶</a></h2>
<p>Installing iprPy to Python in develop mode means that any changes made are
recompiled every time the package is imported.  This makes it possible for
users to easily make their own changes and modifications as needed.  However,
it makes updating slightly more complicated.</p>
<ol class="arabic">
<li><p>Development of the <a class="reference external" href="https://github.com/usnistgov/atomman/">atomman</a> Python package is closely aligned to iprPy.
As such, atomman should be updated using pip whenever iprPy is updated</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">pip install -U atomman</span>
</pre></div>
</div>
</li>
<li><p>If you forked iprPy from github, you can pull any changes.  Note that any
changes you personally made would have to be committed and may lead to
conflicts that need to be resolved.</p></li>
<li><p>If you downloaded iprPy, you can download a new version.  Then, either
uninstall the old version and install the new version, or overwrite the
files in the old version with the new.</p></li>
</ol>
</div>
<div class="section" id="uninstalling-iprpy">
<h2>Uninstalling iprPy<a class="headerlink" href="#uninstalling-iprpy" title="Permalink to this headline">¶</a></h2>
<p>The iprPy code is entirely self-contained and can be completely removed simply
by deleting it.  If you want to keep the files but uninstall the package from
Python, move iprPy to a new directory.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Setup</a><ul>
<li><a class="reference internal" href="#installing-iprpy">Installing iprPy</a></li>
<li><a class="reference internal" href="#updating-iprpy">Updating iprPy</a></li>
<li><a class="reference internal" href="#uninstalling-iprpy">Uninstalling iprPy</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="intro.html"
                        title="previous chapter">Introduction to iprPy</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="overview.html"
                        title="next chapter">iprPy Package Components</a></p>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="overview.html" title="iprPy Package Components"
             >next</a> |</li>
        <li class="right" >
          <a href="intro.html" title="Introduction to iprPy"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">iprPy 0.10.2 documentation</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.2.
    </div>
  </body>
</html>